<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>axicdma: xaxicdma_bdring.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">axicdma
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xaxicdma__bdring_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xaxicdma_bdring.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga18d5a9deaab709c610d32e42c77df952"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#ga18d5a9deaab709c610d32e42c77df952">XAxiCdma_BdRingCntCalc</a> (u32 Alignment, u32 Bytes, UINTPTR BdBuffAddr)</td></tr>
<tr class="memdesc:ga18d5a9deaab709c610d32e42c77df952"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function calculates how many BDs can be built using given number of bytes of memory, according to alignment provided.  <a href="group__axicdma.html#ga18d5a9deaab709c610d32e42c77df952">More...</a><br/></td></tr>
<tr class="separator:ga18d5a9deaab709c610d32e42c77df952"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1525cddb18badb5737c1017f2a0d34e1"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#ga1525cddb18badb5737c1017f2a0d34e1">XAxiCdma_BdRingMemCalc</a> (u32 Alignment, int NumBd)</td></tr>
<tr class="memdesc:ga1525cddb18badb5737c1017f2a0d34e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function calculates how much memory is needed to build requested number of BDs.  <a href="group__axicdma.html#ga1525cddb18badb5737c1017f2a0d34e1">More...</a><br/></td></tr>
<tr class="separator:ga1525cddb18badb5737c1017f2a0d34e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae1333cf9309c85b0f620e026c889e01c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#gae1333cf9309c85b0f620e026c889e01c">XAxiCdma_BdSetCurBdPtr</a> (XAxiCdma *InstancePtr, UINTPTR CurBdPtr)</td></tr>
<tr class="memdesc:gae1333cf9309c85b0f620e026c889e01c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function set the Current BD ptr of a BD.  <a href="group__axicdma.html#gae1333cf9309c85b0f620e026c889e01c">More...</a><br/></td></tr>
<tr class="separator:gae1333cf9309c85b0f620e026c889e01c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab6f6efa84ee457f155a4c7a94e4227da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__axicdma.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#gab6f6efa84ee457f155a4c7a94e4227da">XAxiCdma_BdRingGetCurrBd</a> (XAxiCdma *InstancePtr)</td></tr>
<tr class="memdesc:gab6f6efa84ee457f155a4c7a94e4227da"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function grabs a copy of the current BD pointer from the hardware.  <a href="group__axicdma.html#gab6f6efa84ee457f155a4c7a94e4227da">More...</a><br/></td></tr>
<tr class="separator:gab6f6efa84ee457f155a4c7a94e4227da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6dda9c5b4ded0bdbf1e85d6532461ef6"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#ga6dda9c5b4ded0bdbf1e85d6532461ef6">XAxiCdma_BdRingGetCnt</a> (XAxiCdma *InstancePtr)</td></tr>
<tr class="memdesc:ga6dda9c5b4ded0bdbf1e85d6532461ef6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function gets the total number of BDs in the BD ring.  <a href="group__axicdma.html#ga6dda9c5b4ded0bdbf1e85d6532461ef6">More...</a><br/></td></tr>
<tr class="separator:ga6dda9c5b4ded0bdbf1e85d6532461ef6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga07f505ed309a6eb2172e7e8e154fa082"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#ga07f505ed309a6eb2172e7e8e154fa082">XAxiCdma_BdRingGetFreeCnt</a> (XAxiCdma *InstancePtr)</td></tr>
<tr class="memdesc:ga07f505ed309a6eb2172e7e8e154fa082"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function gets the number of free BDs.  <a href="group__axicdma.html#ga07f505ed309a6eb2172e7e8e154fa082">More...</a><br/></td></tr>
<tr class="separator:ga07f505ed309a6eb2172e7e8e154fa082"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4677cddba8354ca3979f9b6ae386ffde"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#ga4677cddba8354ca3979f9b6ae386ffde">XAxiCdma_BdRingSnapShotCurrBd</a> (XAxiCdma *InstancePtr)</td></tr>
<tr class="memdesc:ga4677cddba8354ca3979f9b6ae386ffde"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function grabs a copy of the current BD pointer from the hardware.  <a href="group__axicdma.html#ga4677cddba8354ca3979f9b6ae386ffde">More...</a><br/></td></tr>
<tr class="separator:ga4677cddba8354ca3979f9b6ae386ffde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1141024e912e7012d2c716cef9fc791f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#ga1141024e912e7012d2c716cef9fc791f">XAxiCdma_BdSetTailBdPtr</a> (XAxiCdma *InstancePtr, UINTPTR TailBdPtr)</td></tr>
<tr class="memdesc:ga1141024e912e7012d2c716cef9fc791f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function set the Tail BD ptr of a BD.  <a href="group__axicdma.html#ga1141024e912e7012d2c716cef9fc791f">More...</a><br/></td></tr>
<tr class="separator:ga1141024e912e7012d2c716cef9fc791f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabfe3657b7aad9487946d6bb436aeba18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__axicdma.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#gabfe3657b7aad9487946d6bb436aeba18">XAxiCdma_BdRingNext</a> (XAxiCdma *InstancePtr, <a class="el" href="group__axicdma.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *BdPtr)</td></tr>
<tr class="memdesc:gabfe3657b7aad9487946d6bb436aeba18"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function gets the next BD of the current BD on the BD ring.  <a href="group__axicdma.html#gabfe3657b7aad9487946d6bb436aeba18">More...</a><br/></td></tr>
<tr class="separator:gabfe3657b7aad9487946d6bb436aeba18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga24af2a3eacaf56c972e6313683a3f7e0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__axicdma.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#ga24af2a3eacaf56c972e6313683a3f7e0">XAxiCdma_BdRingPrev</a> (XAxiCdma *InstancePtr, <a class="el" href="group__axicdma.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *BdPtr)</td></tr>
<tr class="memdesc:ga24af2a3eacaf56c972e6313683a3f7e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function gets the previous BD of the current BD on the BD ring.  <a href="group__axicdma.html#ga24af2a3eacaf56c972e6313683a3f7e0">More...</a><br/></td></tr>
<tr class="separator:ga24af2a3eacaf56c972e6313683a3f7e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab36598e09c09ffa680b6c0f207baf9f5"><td class="memItemLeft" align="right" valign="top">LONG&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#gab36598e09c09ffa680b6c0f207baf9f5">XAxiCdma_BdRingCreate</a> (XAxiCdma *InstancePtr, UINTPTR PhysAddr, UINTPTR VirtAddr, u32 Alignment, int BdCount)</td></tr>
<tr class="memdesc:gab36598e09c09ffa680b6c0f207baf9f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function creates the BD ring for the driver instance.  <a href="group__axicdma.html#gab36598e09c09ffa680b6c0f207baf9f5">More...</a><br/></td></tr>
<tr class="separator:gab36598e09c09ffa680b6c0f207baf9f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3183f9f25654d2a066c19213f29897be"><td class="memItemLeft" align="right" valign="top">LONG&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#ga3183f9f25654d2a066c19213f29897be">XAxiCdma_BdRingClone</a> (XAxiCdma *InstancePtr, <a class="el" href="group__axicdma.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *TemplateBdPtr)</td></tr>
<tr class="memdesc:ga3183f9f25654d2a066c19213f29897be"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function clones all BDs in the BD ring to be the same as the given BD.  <a href="group__axicdma.html#ga3183f9f25654d2a066c19213f29897be">More...</a><br/></td></tr>
<tr class="separator:ga3183f9f25654d2a066c19213f29897be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga27dd0cdc27b7a724533db75336c4acc6"><td class="memItemLeft" align="right" valign="top">LONG&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#ga27dd0cdc27b7a724533db75336c4acc6">XAxiCdma_BdRingAlloc</a> (XAxiCdma *InstancePtr, int NumBd, <a class="el" href="group__axicdma.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> **BdSetPtr)</td></tr>
<tr class="memdesc:ga27dd0cdc27b7a724533db75336c4acc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function requests number of BDs from the BD ring.  <a href="group__axicdma.html#ga27dd0cdc27b7a724533db75336c4acc6">More...</a><br/></td></tr>
<tr class="separator:ga27dd0cdc27b7a724533db75336c4acc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9be6e4072c2a17f4519ffa9f9ec3332f"><td class="memItemLeft" align="right" valign="top">LONG&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#ga9be6e4072c2a17f4519ffa9f9ec3332f">XAxiCdma_BdRingUnAlloc</a> (XAxiCdma *InstancePtr, int NumBd, <a class="el" href="group__axicdma.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *BdSetPtr)</td></tr>
<tr class="memdesc:ga9be6e4072c2a17f4519ffa9f9ec3332f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function tries to free the number of BDs back to the ring.  <a href="group__axicdma.html#ga9be6e4072c2a17f4519ffa9f9ec3332f">More...</a><br/></td></tr>
<tr class="separator:ga9be6e4072c2a17f4519ffa9f9ec3332f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3c5cd26d9fd3311c2ccfa4253c587e68"><td class="memItemLeft" align="right" valign="top">LONG&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#ga3c5cd26d9fd3311c2ccfa4253c587e68">XAxiCdma_BdRingToHw</a> (XAxiCdma *InstancePtr, int NumBd, <a class="el" href="group__axicdma.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *BdSetPtr, XAxiCdma_CallBackFn CallBackFn, void *CallBackRef)</td></tr>
<tr class="memdesc:ga3c5cd26d9fd3311c2ccfa4253c587e68"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function tries to enqueue the number of BDs to the hardware.  <a href="group__axicdma.html#ga3c5cd26d9fd3311c2ccfa4253c587e68">More...</a><br/></td></tr>
<tr class="separator:ga3c5cd26d9fd3311c2ccfa4253c587e68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafce6a8283bdec8b9c35169c7cd29f4dc"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#gafce6a8283bdec8b9c35169c7cd29f4dc">XAxiCdma_BdRingFromHw</a> (XAxiCdma *InstancePtr, int BdLimit, <a class="el" href="group__axicdma.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> **BdSetPtr)</td></tr>
<tr class="memdesc:gafce6a8283bdec8b9c35169c7cd29f4dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function tries to retrieve completed BDs from the hardware.  <a href="group__axicdma.html#gafce6a8283bdec8b9c35169c7cd29f4dc">More...</a><br/></td></tr>
<tr class="separator:gafce6a8283bdec8b9c35169c7cd29f4dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab204e3f92e4edd3865ecf6b344f0b864"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__axicdma.html#gab204e3f92e4edd3865ecf6b344f0b864">XAxiCdma_BdRingFree</a> (XAxiCdma *InstancePtr, int NumBd, <a class="el" href="group__axicdma.html#ga33f9ce1ca035334d63cd08d4cf26daea">XAxiCdma_Bd</a> *BdSetPtr)</td></tr>
<tr class="memdesc:gab204e3f92e4edd3865ecf6b344f0b864"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the BDs back to the free pool of the BD ring.  <a href="group__axicdma.html#gab204e3f92e4edd3865ecf6b344f0b864">More...</a><br/></td></tr>
<tr class="separator:gab204e3f92e4edd3865ecf6b344f0b864"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
